/**
 * Copyright (C) 2009-2013 FoundationDB, LLC
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package com.foundationdb.qp.operator;

import com.foundationdb.qp.row.Row;

public interface UpdateFunction {
    /**
     * Updates the given row by returning another row with the required modifications.
     * @param original the original row, which will remain untouched
     * @param context the query context for evaluation
     * @param bindings the variable bindings for evaluation
     * @return a row of the same type as the original, but different fields
     * @throws IllegalArgumentException if the row could not be updated
     */
    Row evaluate(Row original, QueryContext context, QueryBindings bindings);
}
